Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for pandas API. #55

Merged
merged 15 commits into from
Aug 26, 2020
Merged

Add docs for pandas API. #55

merged 15 commits into from
Aug 26, 2020

Conversation

tjann
Copy link
Contributor

@tjann tjann commented Aug 25, 2020

No description provided.

@tjann tjann requested review from shifucun and beets August 25, 2020 15:57
@tjann
Copy link
Contributor Author

tjann commented Aug 25, 2020

This is how it is structured

image

api/pandas/covariate_dataframe.md Outdated Show resolved Hide resolved
api/pandas/covariate_dataframe.md Outdated Show resolved Hide resolved
api/pandas/time_series.md Outdated Show resolved Hide resolved
Copy link
Contributor

@beets beets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for cleaning up the other pages too

api/pandas/covariate_dataframe.md Outdated Show resolved Hide resolved

You can find a list of `StatisticalVariable`s with human-readable names [here](/statistical_variables.html).

## Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add an example for an overly constrained query that results in a value error

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no optional constraints for this function

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add one with no data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added an example for no data for both time series and multivariate data frame.


The **Data Commons Pandas API** is a superset of the Data Commons Python API:
all functions from the Python API are also accessible from
the Pandas API, and supplemental functions help with directly creating pandas
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: add link for "pandas", and should it be Pandas?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pandas is technically lower case, but I've upper cased it for the "Pandas API". I added a link.

api/pandas/time_series.md Outdated Show resolved Hide resolved
Copy link
Contributor

@beets beets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@tjann tjann merged commit 6e21c83 into datacommonsorg:master Aug 26, 2020
@tjann tjann deleted the pandas-docs branch August 26, 2020 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants